Find Delivery Order Logs
GET {{base_url}}/delivery-orders/logs
Description
This API endpoint is used to find delivery order logs based on various criteria.
API Request:
Headers:
| Name | Description |
|---|---|
| tenantId | A string identifying the tenant. |
| countryCode | A string representing the country code. |
| Query Parameters: |
| Name | Type | Description |
|---|---|---|
| pageNumber | integer | The page number for pagination. |
| pageSize | integer | The size of each page for pagination. |
| isActive | boolean | Indicates whether the order log is active. |
| status | string | The status of the delivery order log. |
| isAssigned | boolean | Indicates whether the order log is assigned. |
| orderRef | array | An array of order reference strings. |
| trackingCode | array | An array of tracking code strings. |
| startDate | string | The start date for filtering order logs. |
| endDate | string | The end date for filtering order logs. |
| Responses: |
- 200 OK:
{
"status": true,
"statusCode": 0,
"message": "Delivery order logs found.",
"data": {},
"errors": []
}
- 400 Bad Request:
{
"status": false,
"statusCode": 400,
"message": "Invalid reference supplied.",
"errors": [
{
"message": "Invalid reference supplied.",
"descriptiveMessage": "The provided reference is not valid. Please ensure correct values are supplied."
}
]
}
- 404 Not Found:
{
"status": false,
"statusCode": 404,
"message": "Delivery Order log not found.",
"errors": [
{
"message": "Delivery Order log not found.",
"descriptiveMessage": "No delivery order logs were found matching the specified criteria."
}
]
}
LANGUAGE
CURL REQUEST
curl --request GET \
--url /delivery-orders/logs \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!